CRC.h

Go to the documentation of this file.

#ifndef CRC_H_
#define CRC_H_

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

/* Instance list */
#define CRC_INSTANCE_0   0x00u
#define CRC_INSTANCE_1   0x01u

/* Masks for CRCConfig_t */
#define CRC_INSTANCE_0_MASK    0x00u
#define CRC_INSTANCE_1_MASK    0x10u
#define CRC_CCITT              0x00u
#define CRC_32                 0x04u
#define CRC_NO_MSB_SWAP        0x00u
#define CRC_MSB_SWAP           0x02u
#define CRC_NO_RESULT_INV      0x00u
#define CRC_RESULT_INV         0x01u

/* DMA Channels occupied by this fn. */
#define CRC_DMA_CH_0        (10u)

#define CRC_DMA_CH_1        (11u)

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/* Where XX = pu32StartAddress, YY = u32NoOfWords, ZZ = pu32Result */
#define CRC32_0(XX, YY, ZZ) u8fnCRC(XX, YY, ZZ, 0xFFFFFFFFu, \
                                    CRC_DMA_CH_0, CRC_0_32)
#define CRC32_1(XX, YY, ZZ) u8fnCRC(XX, YY, ZZ, 0xFFFFFFFFu, \
                                    CRC_DMA_CH_1, CRC_1_32)
#define CCITT_0(XX, YY, ZZ) u8fnCRC(XX, YY, ZZ, CLEAR, CRC_DMA_CH_0, \
                                    CRC_0_CCITT)
#define CCITT_1(XX, YY, ZZ) u8fnCRC(XX, YY, ZZ, CLEAR, CRC_DMA_CH_1, \
                                    CRC_1_CCITT)

/*** Enums ***/
enum DEFAULT_CRC_CONFIG_INDECES 
{
  CRC_0_CCITT = 0, CRC_1_CCITT, CRC_0_32, CRC_1_32
};

/*** TypeDefs ***/
typedef union 
{
  struct
  {
    vuint8_t Instance: 4;
    vuint8_t Unused: 1;
    vuint8_t Polyg: 1;
    vuint8_t Swap:  1;
    vuint8_t Inv:   1;
  }P;
  vuint8_t A;
} CRCConfig_t;
/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Global ***/

/*** Static ***/

/*** Constant ***/
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          vfnInitCRC
 *
 */
void vfnInitCRC(uint8_t u8Instance, uint32_t u32Remainder);
/*
 ******************************************************************************
 *
 * Function:          u8fnCRC
 *
 */
uint8_t u8fnCRC(const uint8_t* pu8StartAddress,
                const uint32_t u32NOfBytes,
                uint32_t* pu32Result,
                const uint32_t u32Remainder,
                const uint8_t u8DMAChannel,
                const uint8_t u8CRCConfig);
/*
 ******************************************************************************
 *
 * Function:          vfnCRCConfig
 *
 */
static void vfnCRCConfig(CRCConfig_t tConfig);
/*
 ******************************************************************************
 *
 * Function:          vfnCRCConfigDMA
 *
 */
static void vfnCRCConfigDMA(const uint8_t* pu8StartAddress,
                            const uint32_t u32NOfBytes,
                            const uint8_t u8DMAChannel,
                            const CRCConfig_t tCRCConfig);
/*
 ******************************************************************************
 *
 * Function:          vfnCRCIsr
 *
 */
static void vfnCRCIsr(uint8_t u8Instance);
/*
 ******************************************************************************
 *
 * Function:          vfnCRC0Isr
 *
 */
void vfnCRC0Isr(void);
/*
 ******************************************************************************
 *
 * Function:          vfnCRC1Isr
 *
 */
void vfnCRC1Isr(void);
#endif /* CRC_H_ */